GET api/communication/template?communicationType[0]={communicationType[0]}&communicationType[1]={communicationType[1]}&recipientType[0]={recipientType[0]}&recipientType[1]={recipientType[1]}&id[0]={id[0]}&id[1]={id[1]}&startYear={startYear}&endYear={endYear}&includeBody={includeBody}&includePluginTemplate={includePluginTemplate}&allTemplates={allTemplates}&pageNumber={pageNumber}&pageSize={pageSize}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
communicationType

Collection of string

Required

recipientType

Collection of string

Required

id

Collection of string

Required

startYear

integer

None.

endYear

integer

None.

includeBody

boolean

None.

includePluginTemplate

boolean

None.

allTemplates

boolean

None.

pageNumber

integer

None.

pageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfPaginatedResultsOfTemplate
NameDescriptionTypeAdditional information
Result

PaginatedResultsOfTemplate

None.

Success

boolean

None.

ErrorText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "TotalCount": 1,
    "Next": "sample string 2",
    "Results": [
      null,
      {
        "Id": "sample string 1",
        "RecipientType": "Undefined",
        "CommunicationType": "Undefined",
        "StationeryId": 4,
        "From": "sample string 5",
        "ReturnAddress": "sample string 6",
        "Cc": "sample string 7",
        "BCc": "sample string 8",
        "Subject": "sample string 9",
        "Body": "sample string 10",
        "BodyPluginTemplate": "sample string 11",
        "SentDate": "2024-05-07T09:39:31Z",
        "SentBy": null,
        "UserId": 0,
        "Name": null,
        "CreatedDate": "0001-01-01T00:00:00Z",
        "CreatedPersonId": null,
        "UpdatedDate": "0001-01-01T00:00:00Z",
        "UpdatedPersonId": null,
        "CommunicationVersion": "Undefined"
      }
    ]
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:
{"Result":{"TotalCount":1,"Next":"sample string 2","Results":[null,{"Id":"sample string 1","RecipientType":"Undefined","CommunicationType":"Undefined","StationeryId":4,"From":"sample string 5","ReturnAddress":"sample string 6","Cc":"sample string 7","BCc":"sample string 8","Subject":"sample string 9","Body":"sample string 10","BodyPluginTemplate":"sample string 11","SentDate":"2024-05-07T09:39:31Z","SentBy":null,"UserId":0,"Name":null,"CreatedDate":"0001-01-01T00:00:00Z","CreatedPersonId":null,"UpdatedDate":"0001-01-01T00:00:00Z","UpdatedPersonId":null,"CommunicationVersion":"Undefined"}]},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:
<WebMethodResultOfPaginatedResultsOfTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <TotalCount>1</TotalCount>
    <Next>sample string 2</Next>
    <Results>
      <Template xsi:nil="true" />
      <Template>
        <Id>sample string 1</Id>
        <ObjectTypeFlag>Undefined</ObjectTypeFlag>
        <RecipientType>Undefined</RecipientType>
        <CommunicationTypeFlag>Undefined</CommunicationTypeFlag>
        <CommunicationType>Undefined</CommunicationType>
        <StationeryId>4</StationeryId>
        <From>sample string 5</From>
        <ReturnAddress>sample string 6</ReturnAddress>
        <Cc>sample string 7</Cc>
        <BCc>sample string 8</BCc>
        <Subject>sample string 9</Subject>
        <Body>sample string 10</Body>
        <BodyPluginTemplate>sample string 11</BodyPluginTemplate>
        <DateSent>2024-05-07T03:39:31.7801892-06:00</DateSent>
        <SentDate>2024-05-07T09:39:31Z</SentDate>
        <UserId>0</UserId>
        <Created />
        <CreatedDate>0001-01-01T00:00:00Z</CreatedDate>
        <CreatedPersonId xsi:nil="true" />
        <Updated />
        <UpdatedDate>0001-01-01T00:00:00Z</UpdatedDate>
        <UpdatedPersonId xsi:nil="true" />
        <Version>Undefined</Version>
        <CommunicationVersion>Undefined</CommunicationVersion>
      </Template>
    </Results>
  </Result>
</WebMethodResultOfPaginatedResultsOfTemplate>